package com.unswift.annotation.api;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 生成API文档的实体注解
 * @author unswift
 *
 */
@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiEntity {

	/**
	 * 实体类名称
	 * @return
	 */
	String value();
	
	/**
	 * API文档类描述
	 * @return
	 */
	String[] describe() default "";
	/**
	 * 作者
	 * @return
	 */
	String author() default "";
	
	/**
	 * 开发日期
	 * @return
	 */
	String date() default "";
	
	/**
	 * 版本
	 * @return
	 */
	String version() default "1.0.0";
	
	/**
	 * 版本追加
	 * @return
	 */
	ApiVersionAdd[] versionAppend() default {};
}
